Детальная информация о роли

Запрос позволяет получить подробную информацию о роли пользователя.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/role/{идентификатор роли}

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле	Описание	Формат
`name`	Название роли сотрудника.	Строка
`putable`	Признак самостоятельного заказа через приложение. В случае значения `false` пользователи с данной ролью смогут заказывать такси только через менеджеров.	Логическое
`classes`	Список доступных тарифов.	Массив
`limit`	Ограничения на сумму, которую пользователь может потратить на поездки за календарный месяц.	Число
`deletable`	Возможность удаление роли.	Логическое
`_id`	Идентификатор роли.	Строка
`department_id`	Идентификационный номер подразделения.	Строка
`no_specific_limit`	Признак того, что у данной роли отсутствует ограничение на общую стоимость поездок. Возможные значения: - `true` — лимит отсутствует. Значение, переданное в параметре `limit` использоваться не будет. - `false` — лимит присутствует. Необязательное поле.	Логическое
`restrictions`	Блок с информацией об ограничениях роли.	Массив объектов
`type`	Тип ограничения. Возможные значения: - `weekly_date` — ограничения по дням недели. - `range_date` — ограничения по дате.	Строка
`days`	Дни недели, в которые доступен заказ поездки. Возможные значения: - `mo` — понедельник. - `tu` — вторник. - `we` — среда. - `th` — четверг. - `fr` — пятница. - `sa` — суббота. - `su` — воскресенье. Поле используется только для ограничения с типом `weekly_date`.	Массив строк
`start_time`	Время, начиная с которого будет доступен заказ. Формат значений: `ЧЧ:ММ:СС`. Поле используется только для ограничения с типом `weekly_date`.	Строка
`end_time`	Время, до которого будет доступен заказ. Формат значений: `ЧЧ:ММ:СС`. Поле используется только для ограничения с типом `weekly_date`.	Строка
`start_date`	Дата, начиная с которой будет доступен заказ. Формат значений: `YYYY-MM-DDThh:mm:ss` Поле используется только для ограничения с типом `range_date`.	Строка
`geo_restrictions`	Блок с информацией о разрешенных районах поездок.	Массив объектов
`geo_restrictions.source`	Идентификатор района начала поездки. Если поле не задано, то разрешен любой район. Должно быть задано хотя бы одно из полей `source` и `destination`.	Строка
`geo_restrictions.destination`	Идентификатор района конца поездки. Если поле не задано, то разрешен любой район. Должно быть задано хотя бы одно из полей `source` и `destination`.	Строка

Пример запроса

GET business.taxi.yandex.ru/api/1.0/client/a2...d09/role/1e0...fbd
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "name": "Тестовая роль",
  "putable": false,
  "classes": [
    "vip",
    "minivan",
    "econom",
    "business",
    "comfortplus"
  ],
  "limit": 0,
  "deletable": false,
  "_id": "1e0202a78f894ad38127aecf31140fbd",
  "department_id": "233e725b0511459da7b38cb24f2d8fd7",
  "restrictions": [
         {
             "type":"weekly_date",
             "end_time":"22:00:00",
             "start_time":"23:59:00",
             "days":["mo","tu","fr"]
         }
     ],
  "geo_restrictions": [
         {
             "source": "geo_restriction_id1", 
             "destination": "geo_restriction_id2"
         },
         {
             "source": "geo_restriction_id3"
         }
     ]
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
401 — был передан неверный OAuth-токен.
403 — у клиента не хватает прав на выполнение данного запроса.
404 — запрашиваемая запись не найдена.

Была ли статья полезна?

Список ролей сотрудников

Создание новой роли